package ace.cmp.openfeign.core;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.cloud.openfeign.FeignClientsConfiguration;
import org.springframework.context.annotation.Import;

/**
 * copy from {@link EnableFeignClients}.
 * 1、增加url属性获取顺序：不存在，则从配置中获取url
 * 2、增加path属性获取顺序：不存在，则从配置中获取path
 * 3、增加注入过滤流程：
 * feign过滤条件配置
 * ace.cloud.openfeign.exclude.names 过滤的指定feign name
 * ace.cloud.openfeign.exclude.class-names 过滤的指定feign class name
 * ace.cloud.openfeign.contract-exclude.class-names 过滤需要注入的feign class name
 * ace.cloud.openfeign.contract-exclude.names 过滤需要注入的feign name
 * .
 * @author caspar
 **/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(AceFeignClientsRegistrar.class)
public @interface EnableAceFeignClients {

  /**
   * Alias for the {@link #basePackages()} attribute. Allows for more concise annotation
   * declarations e.g.: {@code @ComponentScan("org.my.pkg")} instead of
   * {@code @ComponentScan(basePackages="org.my.pkg")}.
   * @return the array of 'basePackages'.
   */
  String[] value() default {};

  /**
   * Base packages to scan for annotated components.
   * <p>
   * {@link #value()} is an alias for (and mutually exclusive with) this attribute.
   * <p>
   * Use {@link #basePackageClasses()} for a type-safe alternative to String-based
   * package names.
   * @return the array of 'basePackages'.
   */
  String[] basePackages() default {};

  /**
   * Type-safe alternative to {@link #basePackages()} for specifying the packages to
   * scan for annotated components. The package of each class specified will be scanned.
   * <p>
   * Consider creating a special no-op marker class or interface in each package that
   * serves no purpose other than being referenced by this attribute.
   * @return the array of 'basePackageClasses'.
   */
  Class<?>[] basePackageClasses() default {};

  /**
   * A custom <code>@Configuration</code> for all contract clients. Can contain override
   * <code>@Bean</code> definition for the pieces that make up the client, for instance
   * {@link feign.codec.Decoder}, {@link feign.codec.Encoder}, {@link feign.Contract}.
   *
   * @see FeignClientsConfiguration for the defaults
   * @return list of default configurations
   */
  Class<?>[] defaultConfiguration() default {};

  /**
   * List of classes annotated with @FeignClient. If not empty, disables classpath
   * scanning.
   * @return list of FeignClient classes
   */
  Class<?>[] clients() default {};
}
